很多情况下,我们可能需要在获取或更新缓存时执行一些额外操作,Workbox 的插件通过一系列生命周期函数(比如:cacheWillUpdate)为我们提供了可在请求的生命周期内,以操作请求、响应的方式来控制并添加额外行为的机制,本章我们将对其进行详细介绍。
# 内置插件
Workbox 内置了一些插件以满足我们的日常开发需求,它们分别是:
workbox.backgroundSync.Plugin:用于后台同步;如果网络请求失败,该请求将会被添加到后台同步队列中,并在触发下一个同步事件时重试该请求。workbox.broadcastUpdate.Plugin:用于广播通知;如果缓存被更新,将在 Broadcast Channel 或通过调用 postMessage 来发送通知给订阅者。workbox.cacheableResponse.Plugin:用于判断请求是否可以被缓存;通过该插件,可以只缓存满足指定条件的请求响应。workbox.expiration.Plugin:用于控制缓存的有效期。workbox.rangeRequests.Plugin:通过该插件,可要求 Service Worker 只返回响应的部分内容。 我们已经在前面的章节中对workbox.backgroundSync.Plugin、workbox.broadcastUpdate.Plugin、workbox.cacheableResponse.Plugin及workbox.expiration.Plugin进行了介绍,此处不再重述,本节的剩余部分,我们将对workbox.rangeRequests.Plugin的使用进行讨论。
# Range 请求
播放音视频时,我们往往需要边播边下载以减少用户等待时间,此时便可在请求中添加 Range 头来告知服务器只返回资源的指定部分,其格式如下:
Range: <unit>=<range-start>-<range-end>
@前端进阶之旅: 代码已经复制到剪贴板
<unit>:范围单位(通常为 bytes)。<range-start>:指定单位下,范围的起始值(类型为整数)。<range-end>:指定单位下,范围的结束值(类型为整数),如不指定此值,则表示范围的结束值为资源的末尾。
如果服务器返回的是 Range 响应,状态码为 206(Partial Content);如请求不合法,服务器返回的状态码为 416(Range Not Satisfiable);如果服务器忽略 Range 头,返回整个资源,其状态码为 200。
# workbox.rangeRequests.Plugin
当我们使用缓存来响应包含 Range 头的请求时,
Cache API将忽略 Range 设置并返回完整的资源,基于此,我们往往使用workbox.rangeRequests.Plugin来返回资源指定范围的内容。比如:
workbox.routing.registerRoute(
/\.mp4$/,
new workbox.strategies.CacheFirst({
plugins: [
new workbox.rangeRequests.Plugin()
]
});
);
@前端进阶之旅: 代码已经复制到剪贴板
同其他内置插件一样,我们可以使用
workbox.rangeRequests.createPartialResponse在自定义的请求策略中处理 Range 请求,比如:
const response = await workbox.rangeRequests.createPartialResponse(request, cachedResponse);
@前端进阶之旅: 代码已经复制到剪贴板
需要注意的是,参数
request必须包含Range头,否则将抛出No Range header was found in the Request provided.异常。
# 自定义插件
我们可以通过创建包含以下方法的对象来构建自定义插件:
cacheWillUpdate:方法签名为:({request, response, event}) => Promise<Response|null>,该方法
